home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1997 September / Macworld (1997-09).dmg / Shareware World / Utilities / Text Processing / Alpha / Help / Quick Start < prev    next >
Text File  |  1997-04-11  |  12KB  |  297 lines
  1.  
  2.         Alpha Quick Start
  3.  
  4.  
  5. ===============================================================================
  6. = Contents
  7. ===============================================================================
  8.  
  9.   [ Any underlined text is a hypertext link; clicking on it takes you to 
  10.   another part of the documentation.  Typing "control-." (Pop Position
  11.   from the Search menu) returns you to the starting point.  ]
  12.  
  13.  
  14.     Installation
  15.     Creating and Saving Documents
  16.     Editing Documents
  17.         Drag and Drop
  18.     Searching
  19.         Quick Finds
  20.         Multi-file Searching
  21.     Marks
  22.     The Window
  23.     Text Manipulations
  24.         Wrapping
  25.     Editing "TeX" documents
  26.     Credits and Registration    
  27.  
  28.  
  29. ===============================================================================
  30. = Installation 
  31. ===============================================================================
  32.  
  33. If you are reading this document, installation must be finished.  
  34. Alpha relies on the files in the Tcl and Help subdirectories being in 
  35. the same director as Alpha itself.  The Alpha folder can be anywhere 
  36. on your disks, the only caveat is that the names of any containing folders 
  37. or disks must not contain names brackets, curly braces, or quotes of any kind.  
  38. Alpha creates a subdirectory within the system preferences folder, 
  39. but you should never have to worry about this.
  40.  
  41.  
  42. ===============================================================================
  43. = Creating and Saving Documents 
  44. ===============================================================================
  45.  
  46. Documents can be created in Alpha via the "New…" menu item under the 
  47. file menu.  Existing files can be opened via the "Open…" item, by 
  48. double-clicking on Alpha documents in the finder, or via the FileSets 
  49. submenu underneath the File menu (more on this later).
  50.  
  51. Once a document has been opened, you can modify it by typing in it, 
  52. cutting and pasting, or using drag-and-drop editing.
  53.  
  54. Files can then be saved and/or closed, also via the File menu.
  55.  
  56.  
  57. ===============================================================================
  58. = Editing Documents
  59. ===============================================================================
  60.  
  61. At its most basic, editing in Alpha is very similar to editing within 
  62. any other mac environment.  The current insertion point is shown by 
  63. the blinking insertion point (or the block cursor, depending on your 
  64. settings. The cursor keys can be used to move the insertion point, as 
  65. in any other application.
  66.  
  67. However, Alpha can also move via larger increments of text:
  68.     option-left        - one word left
  69.     option-right    - one word right
  70.     command-left    - beginning of line
  71.     command-right    - end of line
  72.  
  73. Holding down the shift key tells alpha to extend the selection the 
  74. designated distance.
  75.  
  76. [Tip: most of the standard emacs editing commands are also 
  77. available, see the "Edit:Emacs" submenu.]
  78.  
  79. Text can be cut, copied, or pasted by selecting a region of text and 
  80. using the items in the Edit menu. 
  81.  
  82. Additionally, Alpha supports all the latest Drag and Drop technology.  
  83. Any selected piece of text can be dragged to another part of the same 
  84. window, or to another application merely by dragging it. To try this 
  85. out, i) select a piece of text (double-click on a word), ii) move the 
  86. cursor over the selected text (the cursor should now be an open 
  87. hand), and iii) mouse down on the selected text and drag it elsewhere. 
  88. An outline of the selected text will accompany the cursor until you 
  89. release it, and a caret will mark the current insertion point while 
  90. you move the cursor. Note that you must have either system 7.5 or the 
  91. Drag and Drop init installed for this to work. 
  92.  
  93.  
  94. ===============================================================================
  95. = Searching
  96. ===============================================================================
  97.  
  98. Alpha allows searching for character strings in either the 
  99. current window, or within multiple files, whether or not they are 
  100. currently open. 
  101.  
  102. Searching is usually accomplished via the "Search" menu. "Find" 
  103. brings up a dialog box that allows a search string, a string 
  104. optionally used to replace found text, and several options. These 
  105. options are:
  106.     • 'Forword' - Search backwards or forwards.
  107.     • 'Ignore Case' - The search routine can ignore the case of both the 
  108.       search string and the text to which it matches.
  109.     • 'Word Match' - The search only matches complete words.
  110.     • 'Grep' - Regular expression matching. Regular expressions allow 
  111.       searching for specific character patterns, rather than just a 
  112.       single character sequence. See here for more information.
  113.     • 'Mult Files' - see below.
  114.     • 'Patterns' - This is a popup menu that allows search strings to be 
  115.       saved and later re-used.
  116.  
  117. Once a string has been found, the "Search" menu allows the text to 
  118. be replaced with the 'Replace With' string from the "Find" dialog.
  119.  
  120. [Tip: As with all dialogs in Alpha, buttons may be selected 
  121.  from the keyboard by pressing command-c, where 'c' is the first 
  122.  character of the button's text.]
  123.  
  124. [Tip: Pull down the "Search" menu and press the option key. 
  125.  There are several new items. "Search Start" returns the insertion 
  126.  point to where the last search started. "Replace All" uses the 
  127.  search and replace strings to make substitutions through the rest of 
  128.  the file.]
  129.  
  130. Quick Find
  131.  
  132. Alpha allows the Find dialog to be bypassed by "Quick Find" and "Reverse 
  133. Quick Find" from the "Search" menu. The function search for character 
  134. strings as you type. Use Escape or any function to terminate a search. 
  135. Quick finds always ignore case, but do not match words or allow regular 
  136. expressions.
  137.  
  138.  
  139. Multi-File Searches
  140.  
  141. Multi-file searches are accomplished by using file-sets, or lists of 
  142. files. File-sets are usually a list of files in a single directory. 
  143. They can be created either through the file-set menu (under the File 
  144. menu for AlphaLite, a stand-alone menu for the full version of 
  145. Alpha), or through the Find dialog (select multiple files and then 
  146. use the popup menu to select ``New Fileset''). 
  147.  
  148. To create a fileset, you supply a name, the folder that contains the 
  149. files, and a pattern to select which files from the folder are to be 
  150. contained in the fileset. To select all, the pattern should be `*'. To 
  151. select just the files that end in `.tex', the pattern would be 
  152. `*.tex'. To select all files that end in either `.c' or `.h', the 
  153. pattern would be `*.{c,h}'.
  154.  
  155. Once you have a fileset, you search through the entire thing just be 
  156. selecting ``Mult Files'' and the fileset from the popup menu. The `Batch' 
  157. option allows all matches to be listed (not available in AlphaLite).
  158.  
  159.  
  160. ===============================================================================
  161. = Marks
  162. ===============================================================================
  163.  
  164. Alpha maintains allows manipulation of marks through a popup menu over the 
  165. 'M' icon above the vertical scrollbar.  Marks are pointers to particular 
  166. positions in the file.  This file, for instance, has marks pointing to each 
  167. of the major sections of the document (use the Marks menu to go to a 
  168. different section, and then to come back to the 'Marks' section).
  169.  
  170. The marks popup menu (the icon w/ '{}' above the vertical scrollbar) allows 
  171. marks to be automatically established for a file. For instance, 'Mark File' 
  172. will automatically create a mark for each section and subsection of a latex
  173. document.
  174.  
  175.         
  176. ===============================================================================
  177. = The Window
  178. ===============================================================================
  179.  
  180. Alpha's windows have several non-standard features. They are the following:
  181.  
  182. • Command-clicking on the title-bar anywhere but right on the title pulls 
  183.   down a menu showing the window's current mark, and allows marks to be 
  184.   automatically created for all supported modes (C, LaTeX, etc.). A mark is 
  185.   merely a placeholder for a specific position in a file, much like a 
  186.   bookmark.
  187. • Command-clicking on the title pulls down a popup showing the complete 
  188.   pathname of the window's file.
  189. • Option-clicking on the titlebar brings down a menu of include files, if 
  190.   working w/ Symantec.
  191. • Above the vertical scrollbar is a black "split-pane" bar. Double-clicking 
  192.   or dragging the split-pane bar splits the frontmost window into two 
  193.   separately scrollable panes. Either pane can be edited, any changes 
  194.   appear in both panes if they show the same text. Move from one pane to 
  195.   the other by typing control-x, then 'o'. Go back to a single pane by 
  196.   either double-clicking again or dragging the bar back to the top of the 
  197.   window.
  198. • Above the split-pane bar (the '{}' icon) is another way to access the current 
  199.   marks for the front window.
  200. • Above the Marks menu is either nothing, a red disk icon (showing that the 
  201.   window is dirty and needs to be saved), or a lock icon (meaning that the 
  202.   file is read-only).
  203. • The status window at the bottom of the primary display has three popup 
  204.   menus: 
  205.   
  206.   • "File Attributes" menu. Shows various attributes of the current 
  207.     window that can be changed. "MPW", "Think" and "None" refer to how much 
  208.     state is saved in files' resource forks, Usually, you should leave it 
  209.     at "MPW", which tells Alpha to save the current insertion and window 
  210.     positions.  "Mac", "Unix", or "IBM" refers to the way carriage returns 
  211.     are formatted.
  212.  
  213.   • "Mode" menu, which shows the current mode and allows it to be changed.  
  214.     Bindings, keyword colorings, and many other features differ from mode 
  215.     to mode (AlphaLite has only two modes, 'TeX' and 'Brws' which is used 
  216.     to view search results).
  217.  
  218.   • Line menu. Displays current line and column. Clicking calls a dialog 
  219.     that allows a specific line to be found.
  220.  
  221. ===============================================================================
  222. = "Text Manipulations"
  223. ===============================================================================
  224.  
  225. Automatic Wrapping
  226.  
  227. Wrapping refers to Alpha automatically inserting line breaks as you 
  228. type. The 'Config:Mode' (the 'Mode' menu is under the Windows menu 
  229. for AlphaLite) lets you modify several mode-specific flags. One of 
  230. these is 'wordWrap'.
  231.  
  232. When 'wordWrap' is checked, Alpha automatically insert a carriage 
  233. return when a line becomes too long.  
  234.  
  235. If 'Soft Wrap' is on as well (toggle from the windows menu), Alpha 
  236. will ``re-flow'' the entire paragraph whenever the current line gets 
  237. too long or too short.
  238.  
  239.  
  240. Other Text Manipulations
  241.  
  242. From the 'Text' menu:
  243.  
  244. • 'Fill Paragraph' - reflows the current paragraph so that lines are 
  245.   approximately the same length.
  246. • 'Fill region' - does the same to text that is currently selected.
  247. • 'Downcase Region' - converts all selected characters to lower case.
  248. • 'Upcase Region' (hold down option key) - converts all selected 
  249.    characters to upper case.
  250. • 'Text to Alpha' - This menu item prompts the user to select a directory, 
  251.    and then recursively changes the creator of all text files in that 
  252.    directory to Alpha. This is useful if you receive text files created by 
  253.    another editor (Note: this item is under "Utils:File Utils" in the full 
  254.    version of Alpha).
  255.  
  256.  
  257. ===============================================================================
  258. = "TeX" Editing
  259. ===============================================================================
  260.  
  261. Click here for details.
  262.  
  263.  
  264. ===============================================================================
  265. = Credits and Registration
  266. ===============================================================================
  267.  
  268. Alpha and AlphaLite are both shareware, $30. One registration pays for 
  269. both versions, and all future upgrades of either. You may pay either by 
  270. sending a check to:
  271.  
  272.     Peter Keleher
  273.     8006 Barron Street
  274.     Takoma Park, MD 20912
  275.     
  276. or by using the "Register…" app that comes w/ installation. Click here to 
  277. launch the register app.
  278.  
  279. Send bug reports to me at keleher@cs.umd.edu.
  280.  
  281. Alpha's home page is "http://www.cs.umd.edu/~keleher/alpha.html"
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.